.TH E1432_SET_RAMP 3 E1432
.SH NAME
.nf
e1432_set_ramp \- Set debug data ramp
e1432_get_ramp \- Get current value of debug data ramp
.fi
.IX e1432_set_ramp(3) 3
.IX e1432_get_ramp(3) 3
.SH SYNOPSIS
.cS
SHORTSIZ16 e1432_set_ramp(E1432ID hw, SHORTSIZ16 ID,
                          SHORTSIZ16 ramp)
SHORTSIZ16 e1432_get_ramp(E1432ID hw, SHORTSIZ16 ID,
                          SHORTSIZ16 *ramp)
.cE
.SH DESCRIPTION
\fIe1432_set_ramp\fR sets the debug data ramp, for a single channel or
group of channels \fIID\fR, to the value given in \fIramp\fR.

\fIe1432_get_ramp\fR returns the current debug data ramp setting, of a
single channel or group of channels \fIID\fR, into a memory location
pointed to by \fIramp\fR.

This parameter is useful only for debugging, and may not even be
useful for that.  It's main purpose is to aid debugging of hardware
and firmware problems at HP.

This parameter is a "global" parameter.  It applies to an entire E1432
module rather than to one of its channels.  The \fIID\fR parameter is
used only to identify which module the function applies to, and all
channels in that module will report the same value for this parameter.

\fIhw\fR must be the result of a successful call to
\fIe1432_assign_channel_numbers\fR, and specifies the group of
hardware to talk to.

\fIID\fR is either the ID of a group of channels that was obtained
with a call to \fIe1432_create_channel_group\fR, or the ID of a single
channel.

\fIramp\fR determines whether the debug data ramp is turned on.  The
valid values are:

\fBE1432_RAMP_OFF\fR, to not have the ramp.

\fBE1432_RAMP_ON\fR, to turn on the ramp.  When the ramp is on, all
data from the input channels is thrown away, and replaced with
artificial data which contains a smooth ramp.  The ramp is duplicated
for each input channel and starts over with each block read from the
module.  When the data size is set to \fBE1432_DATA_SIZE_16\fR, then
the ramp starts at a raw data value of zero and increments by one lsb
for each sample.  When the data size is set to
\fBE1432_DATA_SIZE_FLOAT32\fR, then the ramp starts at floating-point
1.0, and increments by a small value with each sample.  When the data
size is set to \fBE1432_DATA_SIZE_32\fR or
\fBE1432_DATA_SIZE_32_SERV\fR, the ramp starts at zero and increments
by 65536 lsbs for each sample.  The low 16 bits of the data is all
zero, except that the very bottom bits are set to the channel number.

When the ramp is on, it applies to all input time data transferred
from the module, either to local bus or to to host computer.  If
eavesdropping is enabled then the ramp applies only to the data
transferred to the host, and data going to disk may or may not have
the ramp.  We're not telling.

When the ramp is on and frequency data is enabled, the ramp may or may
not replace the time data that is the input to the FFT.  I think it
will replace the time data if the host has enabled both time and
frequency data to the host, and it will \fInot\fR if no time data is
enabled to the host.  Try it and let me know!

I have no idea what effect ramp will have when doing resampling.  It
probably will not be anything useful.

.SH "RESET VALUE"
After a reset, \fIramp\fR is set to \fBE1432_RAMP_OFF\fR.
.SH "RETURN VALUE"
Return 0 if successful, a (negative) error number otherwise.
